<!doctype html>
<html class="no-js" lang="">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="x-ua-compatible" content="ie=edge">
        <title>Nestify</title>
        <meta name="description" content="">
        <meta name="viewport" content="width=device-width, initial-scale=1">

        <link rel="icon" type="image/x-icon" href="../images/favicon.ico">
	      <link rel="stylesheet" href="../styles/style.css">
    </head>
    <body>

        <div class="navbar navbar-default navbar-fixed-top visible-xs">
            <a href="../" class="navbar-brand">Nestify</a>
            <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
        </div>

        <div class="xs-menu menu" id="mobile-menu">
                <div id="book-search-input" role="search"><input type="text" placeholder="请输入查询关键字"></div>            <compodoc-menu></compodoc-menu>
        </div>

        <div class="container-fluid main">
           <div class="row main">
               <div class="hidden-xs menu">
                   <compodoc-menu mode="normal"></compodoc-menu>
               </div>
               <!-- START CONTENT -->
               <div class="content class">
                   <div class="content-data">











<ol class="breadcrumb">
  <li>类列表</li>
  <li>ExcelHelper</li>
</ol>

<ul class="nav nav-tabs" role="tablist">
        <li class="active">
            <a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
        </li>
        <li >
            <a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
        </li>
</ul>

<div class="tab-content">
    <div class="tab-pane fade active in" id="c-info">
        <p class="comment">
            <h3>文件</h3>
        </p>
        <p class="comment">
            <code>server/src/common/lib/excel.ts</code>
        </p>





            <section>
    <h3 id="index">索引</h3>
    <table class="table table-sm table-bordered index-table">
        <tbody>

                <tr>
                    <td class="col-md-4">
                        <h6><b>方法</b></h6>
                    </td>
                </tr>
                <tr>
                    <td class="col-md-4">
                        <ul class="index-list">
                            <li>
                                    <span class="modifier">Static</span>
                                    <span class="modifier">Async</span>
                                <a href="#export">export</a>
                            </li>
                            <li>
                                    <span class="modifier">Static</span>
                                    <span class="modifier">Async</span>
                                <a href="#load">load</a>
                            </li>
                            <li>
                                    <span class="modifier">Static</span>
                                    <span class="modifier">Async</span>
                                <a href="#loadFromBuffer">loadFromBuffer</a>
                            </li>
                            <li>
                                    <span class="modifier">Static</span>
                                    <span class="modifier">Async</span>
                                <a href="#loadFromFile">loadFromFile</a>
                            </li>
                        </ul>
                    </td>
                </tr>





        </tbody>
    </table>
</section>



            <section>
    
    <h3 id="methods">
        方法
    </h3>
    <table class="table table-sm table-bordered">
        <tbody>
            <tr>
                <td class="col-md-4">
                    <a name="export"></a>
                    <span class="name">
                        <b>
                            <span class="modifier">Static</span>
                            <span class="modifier">Async</span>
                            export
                        </b>
                        <a href="#export"><span class="icon ion-ios-link"></span></a>
                    </span>
                </td>
            </tr>
            <tr>
                <td class="col-md-4">
                    <span class="modifier-icon icon ion-ios-reset"></span>
                    <code>export(dataSource, sheetsMap, fields)</code>
                </td>
            </tr>


            <tr>
                <td class="col-md-4">
                    <div class="io-line">被定义在 <a href="" data-line="102"
                            class="link-to-prism">server/src/common/lib/excel.ts:102</a></div>
                </td>
            </tr>


            <tr>
                <td class="col-md-4">

                    <div class="io-description">
                        <b>参数列表 :</b>
                        <table class="params">
                            <thead>
                                <tr>
                                    <td>名称</td>
                                    <td>可选的</td>
                                </tr>
                            </thead>
                            <tbody>
                                <tr>
                                    <td>dataSource</td>

                                    <td>
                                        否
                                    </td>


                                </tr>
                                <tr>
                                    <td>sheetsMap</td>

                                    <td>
                                        否
                                    </td>


                                </tr>
                                <tr>
                                    <td>fields</td>

                                    <td>
                                        否
                                    </td>


                                </tr>
                            </tbody>
                        </table>
                    </div>
                    <div>
                    </div>
                    <div class="io-description">
                        <b>返回 : </b>    <code>{}</code>

                    </div>
                    <div class="io-description">
                        
                    </div>
                </td>
            </tr>
        </tbody>
    </table>
    <table class="table table-sm table-bordered">
        <tbody>
            <tr>
                <td class="col-md-4">
                    <a name="load"></a>
                    <span class="name">
                        <b>
                            <span class="modifier">Static</span>
                            <span class="modifier">Async</span>
                            load
                        </b>
                        <a href="#load"><span class="icon ion-ios-link"></span></a>
                    </span>
                </td>
            </tr>
            <tr>
                <td class="col-md-4">
                    <span class="modifier-icon icon ion-ios-reset"></span>
                    <code>load(workbook, sheetsMap)</code>
                </td>
            </tr>


            <tr>
                <td class="col-md-4">
                    <div class="io-line">被定义在 <a href="" data-line="24"
                            class="link-to-prism">server/src/common/lib/excel.ts:24</a></div>
                </td>
            </tr>


            <tr>
                <td class="col-md-4">

                    <div class="io-description">
                        <b>参数列表 :</b>
                        <table class="params">
                            <thead>
                                <tr>
                                    <td>名称</td>
                                    <td>可选的</td>
                                </tr>
                            </thead>
                            <tbody>
                                <tr>
                                    <td>workbook</td>

                                    <td>
                                        否
                                    </td>


                                </tr>
                                <tr>
                                    <td>sheetsMap</td>

                                    <td>
                                        否
                                    </td>


                                </tr>
                            </tbody>
                        </table>
                    </div>
                    <div>
                    </div>
                    <div class="io-description">
                        <b>返回 : </b>    <code>{}</code>

                    </div>
                    <div class="io-description">
                        
                    </div>
                </td>
            </tr>
        </tbody>
    </table>
    <table class="table table-sm table-bordered">
        <tbody>
            <tr>
                <td class="col-md-4">
                    <a name="loadFromBuffer"></a>
                    <span class="name">
                        <b>
                            <span class="modifier">Static</span>
                            <span class="modifier">Async</span>
                            loadFromBuffer
                        </b>
                        <a href="#loadFromBuffer"><span class="icon ion-ios-link"></span></a>
                    </span>
                </td>
            </tr>
            <tr>
                <td class="col-md-4">
                    <span class="modifier-icon icon ion-ios-reset"></span>
                    <code>loadFromBuffer(buffer, sheetsMap)</code>
                </td>
            </tr>


            <tr>
                <td class="col-md-4">
                    <div class="io-line">被定义在 <a href="" data-line="17"
                            class="link-to-prism">server/src/common/lib/excel.ts:17</a></div>
                </td>
            </tr>


            <tr>
                <td class="col-md-4">

                    <div class="io-description">
                        <b>参数列表 :</b>
                        <table class="params">
                            <thead>
                                <tr>
                                    <td>名称</td>
                                    <td>可选的</td>
                                </tr>
                            </thead>
                            <tbody>
                                <tr>
                                    <td>buffer</td>

                                    <td>
                                        否
                                    </td>


                                </tr>
                                <tr>
                                    <td>sheetsMap</td>

                                    <td>
                                        否
                                    </td>


                                </tr>
                            </tbody>
                        </table>
                    </div>
                    <div>
                    </div>
                    <div class="io-description">
                        <b>返回 : </b>    <code>{}</code>

                    </div>
                    <div class="io-description">
                        
                    </div>
                </td>
            </tr>
        </tbody>
    </table>
    <table class="table table-sm table-bordered">
        <tbody>
            <tr>
                <td class="col-md-4">
                    <a name="loadFromFile"></a>
                    <span class="name">
                        <b>
                            <span class="modifier">Static</span>
                            <span class="modifier">Async</span>
                            loadFromFile
                        </b>
                        <a href="#loadFromFile"><span class="icon ion-ios-link"></span></a>
                    </span>
                </td>
            </tr>
            <tr>
                <td class="col-md-4">
                    <span class="modifier-icon icon ion-ios-reset"></span>
                    <code>loadFromFile(filePath, sheetsMap)</code>
                </td>
            </tr>


            <tr>
                <td class="col-md-4">
                    <div class="io-line">被定义在 <a href="" data-line="10"
                            class="link-to-prism">server/src/common/lib/excel.ts:10</a></div>
                </td>
            </tr>


            <tr>
                <td class="col-md-4">

                    <div class="io-description">
                        <b>参数列表 :</b>
                        <table class="params">
                            <thead>
                                <tr>
                                    <td>名称</td>
                                    <td>可选的</td>
                                </tr>
                            </thead>
                            <tbody>
                                <tr>
                                    <td>filePath</td>

                                    <td>
                                        否
                                    </td>


                                </tr>
                                <tr>
                                    <td>sheetsMap</td>

                                    <td>
                                        否
                                    </td>


                                </tr>
                            </tbody>
                        </table>
                    </div>
                    <div>
                    </div>
                    <div class="io-description">
                        <b>返回 : </b>    <code>{}</code>

                    </div>
                    <div class="io-description">
                        
                    </div>
                </td>
            </tr>
        </tbody>
    </table>
</section>





    </div>


    <div class="tab-pane fade  tab-source-code" id="c-source">
        <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import * as _ from &#x27;lodash&#x27;;
import * as Excel from &#x27;exceljs&#x27;;

export enum ExcelHandleType {
	KV,
	ARRAY
}

export class ExcelHelper {
	static async loadFromFile(filePath, sheetsMap) {
		const workbook &#x3D; new Excel.Workbook();
		await workbook.xlsx.readFile(filePath);

		return await ExcelHelper.load(workbook, sheetsMap);
	}

	static async loadFromBuffer(buffer, sheetsMap) {
		const workbook &#x3D; new Excel.Workbook();
		await workbook.xlsx.load(buffer);

		return await ExcelHelper.load(workbook, sheetsMap);
	}

	static async load(workbook, sheetsMap) {
		const info &#x3D; {};

		workbook.eachSheet((worksheet) &#x3D;&gt; {
			const sheetMap &#x3D; sheetsMap[worksheet.name];
			if (!sheetMap) {
				console.error(&#x60;${worksheet.name} 工作表映射加载失败！&#x60;)
				return;
			}

			let item &#x3D; null;

			switch (sheetMap.handleType) {
				case ExcelHandleType.KV:
					const rowsMap &#x3D; sheetMap.rowsMap;
					if (!rowsMap) throw new Error(&#x60;${worksheet.name} 行映射加载失败！&#x60;);

					item &#x3D; {};
					worksheet.eachRow((row, rowNumber) &#x3D;&gt; {
						const cellKey &#x3D; row.getCell(1);
						if (!cellKey) return false;

						const mapKey &#x3D; rowsMap[cellKey.value.toString()];
						if (!mapKey) throw new Error(&#x60;${worksheet.name} [row:${rowNumber}] 列映射加载失败！&#x60;);

						item[mapKey] &#x3D; row.getCell(2).value;
					});

					break;
				case ExcelHandleType.ARRAY:
					const cellsMap &#x3D; sheetMap.cellsMap;
					if (!cellsMap) throw new Error(&#x60;${worksheet.name} 表头映射加载失败！&#x60;);

					const titleArr &#x3D; [];

					item &#x3D; [];
					worksheet.getRow(1).eachCell((cell, cellNumber) &#x3D;&gt; {
						const mapKey &#x3D; cellsMap[cell.value.toString()];
						if (!mapKey) throw new Error(&#x60;${worksheet.name} 表头列映射加载失败！&#x60;);

						titleArr[cellNumber] &#x3D; mapKey;
					});

					worksheet.eachRow((row, rowNumber) &#x3D;&gt; {
						if (rowNumber &lt;&#x3D; 1) return false;

						const cellObj &#x3D; {};
						row.eachCell((cell, cellNumber) &#x3D;&gt; {

							const obj &#x3D; titleArr[cellNumber].split(&#x27;.&#x27;);

							if (_.isArray(obj) &amp;&amp; obj.length &gt;&#x3D; 2) {
								if (!cellObj[obj[0]]) {
									cellObj[obj[0]] &#x3D; {};
								}

								cellObj[obj[0]][obj[1]] &#x3D; cell.value;

							} else {
								cellObj[titleArr[cellNumber]] &#x3D; cell.value;
							}

						});

						item.push(cellObj);

					});
				default:
					break;
			}

			info[sheetMap.map || worksheet.name] &#x3D; item;

		});

		return info;
	}

	static async export(dataSource, sheetsMap, fields) {
		const workbook &#x3D; new Excel.Workbook();
		const sheet &#x3D; workbook.addWorksheet(sheetsMap.map);
		const rowsMap &#x3D; sheetsMap.rowsMap;

		const columns &#x3D; fields.map(item &#x3D;&gt; {
			if (!!rowsMap[item]) {
				rowsMap[item].key &#x3D; rowsMap[item].key ? rowsMap[item].key : item;
				return rowsMap[item];
			}
		}).filter(item &#x3D;&gt; !!item);

		const rows &#x3D; dataSource.map(item &#x3D;&gt; {
			const row &#x3D; {};

			Object.keys(rowsMap).forEach(key &#x3D;&gt; {

				if (fields.includes(key)) {
					const handler &#x3D; rowsMap[key].handler || (val &#x3D;&gt; val);
					const headerKey &#x3D; rowsMap[key].key || key;

					const obj &#x3D; key.split(&#x27;.&#x27;);

					if (_.isArray(obj) &amp;&amp; obj.length &gt;&#x3D; 2) {
						row[key] &#x3D; handler(item[obj[0]]);
					} else {
						row[headerKey] &#x3D; handler(item[headerKey]);
					}
				}
			});

			return row;
		});

		sheet.columns &#x3D; columns;
		sheet.addRows(rows);

		return await workbook.xlsx.writeBuffer();
	}
}
</code></pre>
    </div>
</div>







                   </div><div class="search-results">
    <div class="has-results">
        <h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1>
        <ul class="search-results-list"></ul>
    </div>
    <div class="no-results">
        <h1 class="search-results-title">无匹配的结果 "<span class='search-query'></span>"</h1>
    </div>
</div>
</div>
               <!-- END CONTENT -->
           </div>
       </div>

       <script>
            var COMPODOC_CURRENT_PAGE_DEPTH = 1;
            var COMPODOC_CURRENT_PAGE_CONTEXT = 'class';
            var COMPODOC_CURRENT_PAGE_URL = 'ExcelHelper.html';
       </script>

       <script src="../js/libs/custom-elements.min.js"></script>
       <script src="../js/libs/lit-html.js"></script>
       <!-- Required to polyfill modern browsers as code is ES5 for IE... -->
       <script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script>
       <script src="../js/menu-wc.js" defer></script>

       <script src="../js/libs/bootstrap-native.js"></script>

       <script src="../js/libs/es6-shim.min.js"></script>
       <script src="../js/libs/EventDispatcher.js"></script>
       <script src="../js/libs/promise.min.js"></script>
       <script src="../js/libs/zepto.min.js"></script>

       <script src="../js/compodoc.js"></script>

       <script src="../js/tabs.js"></script>
       <script src="../js/menu.js"></script>
       <script src="../js/libs/clipboard.min.js"></script>
       <script src="../js/libs/prism.js"></script>
       <script src="../js/sourceCode.js"></script>
          <script src="../js/search/search.js"></script>
          <script src="../js/search/lunr.min.js"></script>
          <script src="../js/search/search-lunr.js"></script>
          <script src="../js/search/search_index.js"></script>
       <script src="../js/lazy-load-graphs.js"></script>


    </body>
</html>
